Skip to content

Allow override of build git env in docker/base builds#11968

Merged
deepthi merged 5 commits intovitessio:mainfrom
timvaillancourt:allow-docker-build-git-overrides
Dec 21, 2022
Merged

Allow override of build git env in docker/base builds#11968
deepthi merged 5 commits intovitessio:mainfrom
timvaillancourt:allow-docker-build-git-overrides

Conversation

@timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented Dec 14, 2022 •
edited
Loading

Description

This PR allows BUILD_GIT_BRANCH and BUILD_GIT_REV to be passed-into docker builds using Dockerfiles from docker/base. Currently it is possible to override CGO_ENABLED and BUILD_NUMBER, but not these git-related vars

Specifically, this is useful when the BUILD_GIT_BRANCH default is not useful (HEAD) and an override from your CI is needed

$ curl -s localhost:15000/debug/vars|jq .BuildGitBranch
"HEAD"

If possible, please backport to v14+ 🙏

Related Issue(s)

Resolves #11967

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Documentation was added or is not required

Deployment Notes

@vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 14, 2022 •
edited by mattlord
Loading

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

@timvaillancourt timvaillancourt changed the title Pass BUILD_GIT_BRANCH and BUILD_GIT_REV env into docker/base build Allow override of build git env in docker/base builds Dec 14, 2022
@timvaillancourt
Pass BUILD_GIT_BRANCH and BUILD_GIT_REV env into docker build
631eace 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
Fix bootstrap version
a2e75d6 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
Fix bootstrap version, again
fcb3235 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
Fix ws
c9a3955 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt timvaillancourt force-pushed the allow-docker-build-git-overrides branch from 284f465 to c9a3955 Compare December 14, 2022 22:12
@deepthi deepthi added Component: Build/CI Type: Enhancement Logical improvement (somewhere between a bug and feature) Backport to: release-15.0 labels Dec 16, 2022
@deepthi
Copy link
Collaborator

deepthi commented Dec 16, 2022

@frouioui can you take a look? Also seems like we aren't keeping the bootstrap_version up to date in the vitess/base Dockerfiles. Not sure how those are working right now with such an old bootstrap_version.
Separately, we should probably add you and @GuptaManan100 as code owners for docker files.

@frouioui frouioui mentioned this pull request Dec 16, 2022
Closed
@frouioui
Copy link
Member

frouioui commented Dec 16, 2022

Separately, we should probably add you and @GuptaManan100 as code owners for docker files.

@deepthi, done in #11981.

@frouioui
Merge remote-tracking branch 'origin/main' into allow-docker-build-gi…
ac52a30 
…t-overrides

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
frouioui
frouioui approved these changes Dec 16, 2022
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is looking good to me. I am assuming you are doing manual build of vitess/bootstrap and vitess/base on your own and require the git revision to not be HEAD.

@frouioui
Copy link
Member

frouioui commented Dec 16, 2022

Also seems like we aren't keeping the bootstrap_version up to date in the vitess/base Dockerfiles. Not sure how those are working right now with such an old bootstrap_version.

@deepthi - The bootstrap version used by vitess/base is in sync with the one used to build vitess/bootstrap. The branch was just not up-to-date with main. I merged main onto that branch.

@timvaillancourt
Copy link
Contributor Author

timvaillancourt commented Dec 16, 2022 •
edited
Loading

I am assuming you are doing manual build of vitess/bootstrap and vitess/base on your own and require the git revision to not be HEAD.

@frouioui yes, that is correct 👍

I haven't figured out why git returns HEAD but overriding with $GIT_BRANCH from our Jenkins build env fixes it. Some googling suggests it's due to a detached-head state in git, perhaps caused by how the Jenkins Git plugin checks out a branch 🤷‍♂️

mattlord
mattlord approved these changes Dec 21, 2022
View reviewed changes
Copy link
Member

@mattlord mattlord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! ❤️

@deepthi deepthi merged commit 5563eb1 into vitessio:main Dec 21, 2022
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 21, 2022

I was unable to backport this Pull Request to the following branches: release-14.0, release-15.0.

@timvaillancourt timvaillancourt deleted the allow-docker-build-git-overrides branch December 21, 2022 19:02
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Mar 3, 2023
@timvaillancourt @frouioui
Allow override of build git env in docker/base builds (vitessio#11968)
2cbae9a 
* Pass BUILD_GIT_BRANCH and BUILD_GIT_REV env into docker build

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bootstrap version

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bootstrap version, again

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix ws

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: Florent Poinsard <florent.poinsard@outlook.fr>
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Mar 9, 2023
@timvaillancourt @frouioui
Allow override of build git env in docker/base builds (vitessio#11968)
9346eff 
* Pass BUILD_GIT_BRANCH and BUILD_GIT_REV env into docker build

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bootstrap version

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bootstrap version, again

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix ws

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: Florent Poinsard <florent.poinsard@outlook.fr>
@timvaillancourt timvaillancourt mentioned this pull request Mar 9, 2023
Merged
4 tasks
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Mar 10, 2023
@timvaillancourt
Merge pull request #53 from slackhq/slack-vitess-r12.0.5-pr11968
65fa9e8 
Backport: Allow override of build git env in docker/base builds (vitessio#11968)
@timvaillancourt timvaillancourt mentioned this pull request Mar 14, 2023
Merged
4 tasks
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Mar 30, 2023
@timvaillancourt @frouioui
Allow override of build git env in docker/base builds (vitessio#11968)
5039eb7 
* Pass BUILD_GIT_BRANCH and BUILD_GIT_REV env into docker build

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bootstrap version

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bootstrap version, again

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix ws

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: Florent Poinsard <florent.poinsard@outlook.fr>
@timvaillancourt timvaillancourt mentioned this pull request Mar 30, 2023
Closed
4 tasks
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Mar 30, 2023
@timvaillancourt @frouioui
Allow override of build git env in docker/base builds (vitessio#11968)
48c286f 
* Pass BUILD_GIT_BRANCH and BUILD_GIT_REV env into docker build

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bootstrap version

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bootstrap version, again

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix ws

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: Florent Poinsard <florent.poinsard@outlook.fr>
@timvaillancourt timvaillancourt mentioned this pull request Mar 30, 2023
Merged
4 tasks
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Mar 15, 2024
@timvaillancourt @frouioui
Allow override of build git env in docker/base builds (vitessio#11968)
e7666e4 
* Pass BUILD_GIT_BRANCH and BUILD_GIT_REV env into docker build

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bootstrap version

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bootstrap version, again

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix ws

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: Florent Poinsard <florent.poinsard@outlook.fr>
@timvaillancourt timvaillancourt mentioned this pull request Mar 15, 2024
Merged
4 tasks
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Mar 15, 2024
@timvaillancourt @frouioui
Allow override of build git env in docker/base builds (vitessio#11968) (
66147a9 
#256)

* Pass BUILD_GIT_BRANCH and BUILD_GIT_REV env into docker build



* Fix bootstrap version



* Fix bootstrap version, again



* Fix ws

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: Florent Poinsard <florent.poinsard@outlook.fr>
@timvaillancourt timvaillancourt mentioned this pull request Feb 19, 2025
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mattlord mattlord mattlord approved these changes

@frouioui frouioui frouioui approved these changes

@deepthi deepthi Awaiting requested review from deepthi

@derekperkins derekperkins Awaiting requested review from derekperkins derekperkins is a code owner

@dkhenry dkhenry Awaiting requested review from dkhenry

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100

Assignees

No one assigned

Labels

Component: Build/CI Type: Enhancement Logical improvement (somewhere between a bug and feature)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Bug Report: cannot override Docker environment in docker/base builds

4 participants

@timvaillancourt @deepthi @frouioui @mattlord